<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxMemRegionsUnregisterBatch_v1 Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxMemRegionsUnregisterBatch_v1 Struct Reference<div class="ingroups"><a class="el" href="group___m_e_m_o_r_y.html">Memory</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Register a region of memory inside of a heap.  
 <a href="structnvtx_mem_regions_unregister_batch__v1.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4e5ae5cddcd71b61e73884c8ce209588" id="r_a4e5ae5cddcd71b61e73884c8ce209588"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#a4e5ae5cddcd71b61e73884c8ce209588">extCompatID</a></td></tr>
<tr class="separator:a4e5ae5cddcd71b61e73884c8ce209588"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30cd8d0aa3a1fa2137decaa6242bcfbd" id="r_a30cd8d0aa3a1fa2137decaa6242bcfbd"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#a30cd8d0aa3a1fa2137decaa6242bcfbd">structSize</a></td></tr>
<tr class="separator:a30cd8d0aa3a1fa2137decaa6242bcfbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bec6594bb3bef11bf661c1376577f49" id="r_a5bec6594bb3bef11bf661c1376577f49"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#a5bec6594bb3bef11bf661c1376577f49">refType</a></td></tr>
<tr class="separator:a5bec6594bb3bef11bf661c1376577f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad3f35b0c0df9ffdc95c4c083540652f" id="r_aad3f35b0c0df9ffdc95c4c083540652f"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#aad3f35b0c0df9ffdc95c4c083540652f">refCount</a></td></tr>
<tr class="separator:aad3f35b0c0df9ffdc95c4c083540652f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8ffe3559d65e26ee82f67b7b34c6e15" id="r_ae8ffe3559d65e26ee82f67b7b34c6e15"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#ae8ffe3559d65e26ee82f67b7b34c6e15">refElementSize</a></td></tr>
<tr class="separator:ae8ffe3559d65e26ee82f67b7b34c6e15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33bf637ac431bc7e653a66389f52f433" id="r_a33bf637ac431bc7e653a66389f52f433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionnvtx_mem_region_ref__t.html">nvtxMemRegionRef_t</a> const  *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_mem_regions_unregister_batch__v1.html#a33bf637ac431bc7e653a66389f52f433">refElements</a></td></tr>
<tr class="separator:a33bf637ac431bc7e653a66389f52f433"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Register a region of memory inside of a heap. </p>
<p>The heap refers the the heap within which the region resides. This can be from nvtxMemHeapRegister, <code>NVTX_MEM_HEAP_HANDLE_PROCESS_WIDE</code>, or one provided from other extension API.</p>
<p>The regionType arg will define which type is used in <code>regionDescArray</code>. The most commonly used type is NVTX_MEM_TYPE_VIRTUAL_ADDRESS.</p>
<p>The regionCount arg is how many element are in regionDescArray and regionHandleArrayOut.</p>
<p>The regionHandleArrayOut arg points to an array where the tool will provide region handles. If a pointer if provided, it is expected to have regionCount elements. This pointer can be NULL if regionType is NVTX_MEM_TYPE_VIRTUAL_ADDRESS. In this case, the user can use the pointer to the virtual memory to reference the region in other related functions which accept a <a class="el" href="unionnvtx_mem_region_ref__t.html" title="A reference to a memory region (by pointer or handle). Which member of the union will be determined b...">nvtxMemRegionRef_t</a>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00433">433</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a4e5ae5cddcd71b61e73884c8ce209588" name="a4e5ae5cddcd71b61e73884c8ce209588"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e5ae5cddcd71b61e73884c8ce209588">&#9670;&#160;</a></span>extCompatID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t nvtxMemRegionsUnregisterBatch_v1::extCompatID</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00435">435</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<a id="aad3f35b0c0df9ffdc95c4c083540652f" name="aad3f35b0c0df9ffdc95c4c083540652f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad3f35b0c0df9ffdc95c4c083540652f">&#9670;&#160;</a></span>refCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxMemRegionsUnregisterBatch_v1::refCount</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00440">440</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<a id="a33bf637ac431bc7e653a66389f52f433" name="a33bf637ac431bc7e653a66389f52f433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33bf637ac431bc7e653a66389f52f433">&#9670;&#160;</a></span>refElements</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionnvtx_mem_region_ref__t.html">nvtxMemRegionRef_t</a> const* nvtxMemRegionsUnregisterBatch_v1::refElements</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00442">442</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<a id="ae8ffe3559d65e26ee82f67b7b34c6e15" name="ae8ffe3559d65e26ee82f67b7b34c6e15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8ffe3559d65e26ee82f67b7b34c6e15">&#9670;&#160;</a></span>refElementSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxMemRegionsUnregisterBatch_v1::refElementSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00441">441</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<a id="a5bec6594bb3bef11bf661c1376577f49" name="a5bec6594bb3bef11bf661c1376577f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bec6594bb3bef11bf661c1376577f49">&#9670;&#160;</a></span>refType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t nvtxMemRegionsUnregisterBatch_v1::refType</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00438">438</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<a id="a30cd8d0aa3a1fa2137decaa6242bcfbd" name="a30cd8d0aa3a1fa2137decaa6242bcfbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30cd8d0aa3a1fa2137decaa6242bcfbd">&#9670;&#160;</a></span>structSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t nvtxMemRegionsUnregisterBatch_v1::structSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_mem_8h_source.html#l00436">436</a> of file <a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_mem_8h_source.html">nvToolsExtMem.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
